﻿//////////////////////////////////////////////////////////////////
//
// IScriptFile.cs
//
// Copyright (c) 2012 Dan Pike.
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation files
// (the "Software"), to deal in the Software without restriction,
// including without limitation the rights to use, copy, modify, merge,
// publish, distribute, sublicense, and/or sell copies of the Software,
// and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
// SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Interfaces
{
   public interface IScriptFile
   {
      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// The name by which we will refer to this script in the system.
      /// </summary>
      string DisplayName { get; set; }

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// The file containing the script source
      /// </summary>
      string Filename { get; }

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Compile a script file
      /// </summary>
      /// <param name="filename"></param>
      /// <returns></returns>
      bool Compile(string filename);

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Run the global code in the script to create the entity that it manages
      /// </summary>
      bool Initialize();

      ////////////////////////////////////////////////////////////////////////
      /// <summary>
      /// Run the script
      /// </summary>
      /// <param name="runner">The runner returned by initialize()</param>
      /// <param name="methodName">Method to call</param>
      /// <param name="parameters">Parameters to the method</param>
      /// <returns></returns>
      bool Run(object runner, string methodName, object[] parameters);
   }
}
